# Carousel

## Installation

`npm i @snack-uikit/carousel`

[Changelog](./CHANGELOG.md)

[//]: DOCUMENTATION_SECTION_START
[//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
## Carousel
### Props
| name | type | default value | description |
|------|------|---------------|-------------|
| children* | `ReactElement<any, string \| JSXElementConstructor<any>>[]` | - | Массив айтемов |
| className | `string` | - | CSS - класснейм |
| showItems | `number` | 1 | Кол-во отображаемых единовременно айтемов |
| scrollBy | `number` | Math.trunc(show) | Сдвиг айтемов при смене 1 страницы |
| transition | `number` | 0.4 | Время переключения 1 страницы (в s) |
| swipe | `boolean` | true | Переключение страниц свайпом |
| arrows | `boolean` | true | Использовать стрелки для переключения страниц |
| pagination | `boolean` | true | Использовать пагинацию для переключения страниц |
| gap | `string` | var(--dimension-2m) | Расстояние между айтемами |
| state | `{ page: number; onChange(page: number): void; }` | - | Управление состоянием извне |
| infiniteScroll | `boolean` | - | Цикличная прокрутка |


[//]: DOCUMENTATION_SECTION_END
